/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package org.fyx.secure.ejb;

import java.util.Set;
import java.util.logging.Logger;
import org.fyx.secure.entity.SecureUser;

/**
 * Abstraktni trida definujici rozhrani pro kontext systemu fyx.
 * Slouzi jako komunikace mezi vystupnim systemem a jadrem.
 * <p>
 * Implementace je realizovana az na vyssi vrstve, tedy vystupni.
 * Konkretni instance jsou predavany pomoci staticke metody
 * {@link org.fyx.core.context.FyxContextFactory#getContext()}.
 * 
 * @author xljan
 * @see org.fyx.mula.ejb.IsoLanguage
 * @since FYX 1.0
 */
public abstract class FyxContext {
    
    /**
     * Vrati aktualne prihlaseneho uzivatele. Pokud neni uzivatel
     * prihlasen vrati novy objekt typu SecureUser.
     * 
     * @return aktualne prihlaseny uzivatel
     */
    public abstract SecureUser getUser();

    /**
     * Nastavi aktualne prihlaseneho uzivatele.
     * Z bezpecnostnich duvodu je tato funkce protected.
     * 
     * @param user aktualne prihlaseny uzivatel
     */
    protected abstract void setUser(SecureUser user);
    
    /**
     * Vrati true pokud ma uzivatel pravo role, jinak false.
     * 
     * @param role uzivatelska role
     * @return true
     */
    public abstract boolean isUserInRole(String role);
    
    /**
     * Vrati true pokud je uzivatel uspesne prihlasen.
     * 
     * @return true
     */
    public abstract boolean isLogedIn();
    
    /**
     * Nastavi prihlaseni uzivatele.
     * 
     * @param logedIn hodnota prihlaseni
     */
    protected abstract void setLogedIn(boolean logedIn);
    
    /**
     * Vrati aktualne nastaveny jazyk uzivatele v trimistnem ISO kodu.
     * Tyto zkratky jsoudefinovany v 
     * interface {@link org.fyx.mula.ejb.IsoLanguage}
     * 
     * @return iso jazyka
     */
    public abstract String getIsoLanguage();
    
    /**
     * Nastavi uzivatelska prava uzivatele. Tyto prava se nastavuji
     * pri procesu autorizace. Z bezpecnostnich duvodu je metada protected.
     * 
     * @param roles seznam uzivatelskych prav.
     */
    protected abstract void setUserRoles(Set<String> roles);
    
    /**
     * Vrati uzivatelska prava uzivatele. Tyto prava se nastavuji
     * pri procesu autorizace. Z bezpecnostnich duvodu je metada protected.
     * 
     * @return uzivatelska prava
     */
    protected abstract Set<String> getUserRoles();
    
    /**
     * Vrati logger systemu.
     * 
     * @param name jmeno tridy ktera logger pouziva
     * @return logger systemu fyx
     */
    public abstract Logger getLogger(String name);
}
